/**

This file is part of MaCI/GIMnet.

MaCI/GIMnet is free software: you can redistribute it and/or modify it 
under the terms of the GNU Lesser General Public License as published 
by the Free Software Foundation, either version 3 of the License, or 
(at your option) any later version.

MaCI/GIMnet is distributed in the hope that it will be useful, but WITHOUT 
ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or 
FITNESS FOR A PARTICULAR PURPOSE.  See the GNU Lesser General Public 
License for more details.

You should have received a copy of the GNU Lesser General Public 
License along with GIMnet. (See COPYING.LESSER) If not, see 
<http://www.gnu.org/licenses/>.

**/
/**
 * \file
 * \brief Protocol encoder/decoder header for the Unit protocol.
 * \author Antti Maula <antti.maula@tkk.fi>
 */
#ifndef _MACI_UNITDATA_HPP_
#define _MACI_UNITDATA_HPP_
#include "UnitTypes.hpp"
#include "MaCIData.hpp"
#include "common/timestamp.hpp"
#include <vector>

namespace gim {
  namespace binbag{class CBinBag;}
}

namespace MaCI {
  namespace Unit {

    typedef std::vector<const TAvailableUnit *>  TAvailableUnitPtrArray;
    typedef std::vector<const TActiveUnit *> TActiveUnitPtrArray;

    /** Unit protocol parser.
     *
     * This class contains the methods for decoding/encoding a 
     * Unit message.
     */
    class CUnitData : public CMaCIData
    {
    public:
      CUnitData();
      ~CUnitData();

      // Copy constructor.
      CUnitData(const CUnitData &);

      // Assignment operator.
      CUnitData &operator=(const CUnitData &);

      // Interface for moving data around
      bool DecodeFrom(gim::binbag::CBinBag *aBinBag);
      void Reset();
      void Print(const int level) const;


      /** Set timestamp element.
       * 
       */
      bool SetTimestamp(const Common::TTimestamp &aStamp);


      /** Set command element.
       * This function stores a element of type TCommand.
       *
       * @return                'true' if element was succesfully added,
       *                        'false' if element already exists.
       */
      bool SetCommand(const TCommand &aCmd);


      /** Set Unit Identifier element (TUnitId).
       *
       */
      bool SetUnitId(const TUnitId &aUnitId);


      bool SetUnitPose(const TUnitPose &aUnitPose);

      
      /** 
       *
       *
       * @return                'true' if element was succesfully added,
       *                        'false' if element already exists.
       */
      bool AddAvailableUnit(const TAvailableUnit &aAvailableUnit);


      /** 
       *
       *
       * @return                'true' if element was succesfully added,
       *                        'false' if element already exists.
       */
      bool AddActiveUnit(const TActiveUnit &aActiveUnit);


      /** Get pointer to TTimestamp element.
       * 
       * @return                 Pointer to element if such exists, 
       *                         NULL if element doesn't exists in the
       *                         container.
       */
      const MaCI::Common::TTimestamp *GetTimestamp(void) const;
      

      /** Get pointer to TCommand element.
       *
       * @return                 Pointer to element if such exists, 
       *                         NULL if element doesn't exists in the
       *                         container.
       */
      const TCommand *GetCommand(void) const;


      const TUnitId *GetUnitId(void) const;
      const TUnitPose *GetUnitPose(void) const;
      const TAvailableUnitPtrArray &GetAvailableUnitArray(void) const;
      const TActiveUnitPtrArray &GetActiveUnitArray(void) const;


    private:
      const Common::TTimestamp *iTimestampPtr; ///< Pointer to timestamp if exists
      const TCommand *iCommandPtr; ///< Pointer to command if any.
      const TUnitId *iUnitIdPtr;  ///< Pointer to unitId if any
      const TUnitPose *iUnitPosePtr;
      TAvailableUnitPtrArray iAvailableUnitArray; ///< Pointer array to AvailableUnits
      TActiveUnitPtrArray iActiveUnitArray; ///< Pointer array to active units.
    };
    
  }
}

#endif
